/*
 * Copyright 2016 SimplifyOps, Inc. (http://simplifyops.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.dtolabs.rundeck.core.execution.workflow.state;

import java.util.Date;
import java.util.Map;

/**
 * Describes the state of a step, which includes the execution status, and possible metadata
 */
public interface StepState extends HasExecutionState {
    /**
     * @return the execution state
     */
    public ExecutionState getExecutionState();

    /**
     * @return Any metadata
     */
    public Map getMetadata();

    /**
     * @return Potential error message if state is failed
     */
    public String getErrorMessage();

    /**
     * @return Timestamp that the executionState left WAITING
     */
    public Date getStartTime();
    /**
     * @return Last timestamp that the executionState changed
     */
    public Date getUpdateTime();

    /**
     * @return Timestamp that the executionState was completed
     */
    public Date getEndTime();
}
